home *** CD-ROM | disk | FTP | other *** search
/ CD Classic / CD CLASSIC #1.iso / kdgraf / kdgraf.doc < prev    next >
Text File  |  1989-06-04  |  24KB  |  447 lines
  1.  
  2.  
  3.                                   KDGraf
  4.                           Version 1.3  -  May 1989
  5.                    A Product of KD Ranch Enterprises (c)
  6.  
  7.  
  8. GENERAL:
  9.  
  10.     KDGraf is a pull-down, menu-driven graphics package for EGA/VGA users.
  11.     It will not display graphics on a CGA system.  Bars, 3D Bars, Lines,
  12.     3D Lines and Pies are supported.  Graphs can be saved and retrieved.   
  13.     They can be printed on most Epson compatible printers (FX-80 and above).
  14.     A maximum of 6 sets of values can be displayed over 15 occurrences --
  15.     i.e., up to 90 values can be shown.
  16.  
  17.     KDGraf was written in Turbo Pascal 5.0. 
  18.  
  19.  
  20. HISTORY:
  21.  
  22.     Version 1.0  - Beta Only (April 1988).
  23.     Version 1.1  - Initial Release (June 1988).
  24.     Version 1.2  - Minor Bug Fixes (Sept.1988).
  25.     Version 1.3  - Added Scaling Enhancements (May 1989).
  26.  
  27.  
  28. COMMAND SYNTAX: KDGraf [grafname]
  29.  
  30.     The only parameter supported by KDGraf is the name of an existing graph.
  31.     All graphs are saved with the extension .KDG.  Do not use the extension
  32.     when calling a graph with the command parameter.  The called graph will be 
  33.     loaded at startup.  The parameter is not required.  Any existing graph in 
  34.     the current directory can be called from within the program.
  35.  
  36. USAGE:
  37.  
  38.     Upon execution, a pull-down menu system will be displayed.
  39.     The idea here is to use the menus to select the type of graph,
  40.     input the data, make whatever cosmetic adjustments you might be
  41.     interested in, and then display and/or print your graph.
  42.                         
  43.     Hopefully, to create a reasonably useful and attractive graph,  
  44.     this should be pretty simple. If not, the author (me) has failed
  45.     in one of the primary goals.  There are, however, some intricacies
  46.     that may take further explanation -- that's why we have a .DOC file.
  47.  
  48.     I do not plan to describe everything possible in this .DOC file.
  49.     Most functions will be obvious.  The following information will
  50.     concentrate on those that aren't.
  51.  
  52.     Additionally, if the package you have received is intact, there should
  53.     be 18 example graphs to help you with most of the functions.  All data
  54.     and settings used to create these graphs are always included in the
  55.     saved graph file and are available from the menu system.
  56.  
  57.  
  58. FUNCTIONS:
  59.  
  60.     The Pull-Down Menu System:
  61.        These menus operate like most other pull-down systems.  Generally,
  62.        you hilite your selection with the arrow keys and then press ENTER,
  63.        or simply select the item you want by pressing the first character 
  64.        (KeyLetter) of any item within the current selection menu.
  65.  
  66.        A selection from a menu could do a lot of different things:
  67.          - just pull-down another selection menu.
  68.          - set an item as data that affects the graph.
  69.          - open a data input area asking for you to input some data.
  70.          - open a special sub-process for various reasons.
  71.          - actually execute something.
  72.  
  73.        What each menu does will become evident rather quickly.  The "Help"
  74.        function is designed to let you know what might happen to you before
  75.        it happens in addition to providing a hint or two about input data.
  76.  
  77.        There are a few special keys that may be of use:
  78.          F1 - is usually a "HELP" key and will provide a little information
  79.               about where you currently are and what you will get next.
  80.          F2 - is the pull/pop key.  If a menu is currently displayed, F2 will
  81.               pop you all the way back to ground zero (Data Display). If
  82.               you are at ground zero, it will pull back all the menus that
  83.               were last activated. Actually, ground zero is of very little use.
  84.           / - takes you to the Main (Top) Menu from almost everywhere.  This is 
  85.               a much more valuable key.  For example, the keys "/VG" will show
  86.               your graph as long as you are not currently in a process that
  87.               requires Esc to leave.
  88.         Esc - moves you back one level in the menu process or takes you out of
  89.               sub-processes (e.g. help, save, etc.). Sometimes, this is the
  90.               only avenue of escape.
  91.  
  92.        The last line of the screen, The Message Line, will always show which
  93.        keys are active and what they do.  Once you play with the menus a 
  94.        while, you should have little problem.
  95.  
  96.  
  97.     Menu Detail (based on Main Menu options):
  98.  
  99.     *** Many of the options listed below have some common selection criteria.
  100.         Most of these are listed under APPENDIX I. ***
  101.        
  102.        ChartType:
  103.          Allows you to select one of 13 types.  I am not going to list them
  104.          here.  When you change a choice here, you are automatically thrown to
  105.          the View Graph selection.  It may seem a little strange at first, but
  106.          I believe you will find it useful.
  107.  
  108.        Data:
  109.          Data comes in two varieties - Values and Names.  You will find that a
  110.          graph is constructed by use of a matrix with the "names" of a set
  111.          of "values" listed down the side and "labels" listed along the top.
  112.          This is where you enter all that stuff.  You will also be allowed to
  113.          give specific color and pattern information to each set of values and
  114.          names from here.  Specific details about what impact the data values,
  115.          names, colors and patterns may have are covered as we go on.
  116.  
  117.        Titles:
  118.          Three titles can be entered which will automatically be centered on
  119.          the top of the graph. From here you also enter the X and Y axis titles
  120.          which will be placed appropriately.  You can vary the Font, Color, and
  121.          Size of any of these (See APPENDIX).
  122.  
  123.        Notes:
  124.          Up to 9 notes can be entered and placed on the graph anywhere you 
  125.          want. Again, Font, Color and Size can be selected along with the
  126.          position.  The position is controlled by a set of X,Y coordinates.
  127.          You will probably have to play with the positioning a bit to get the
  128.          note exactly where you want it. For general information, the notes are
  129.          connected at the chosen X,Y coordinates at their left center.  X 
  130.          coordinates range from 0 to 639, Y from 0 to 349.
  131.  
  132.        Enhancements:
  133.          This is the most complicated, least necessary, most used and hardest 
  134.          to explain section of the whole package.This is where most of the
  135.          cosmetic changes are made to the graphs.  It is also the only menu
  136.          that varies with a ChartType selection (a Pie requires different stuff
  137.          than the other 12 types do).  Here goes:
  138.  
  139.             BackGround - Select a background color. 0 (black) is the default.
  140.                          Any other color selected causes that color's number to
  141.                          mean black.  That way, you don't lose a color and all
  142.                          that you had set up will still show when you switch.
  143.                          Think about it -- it makes sense (I think).
  144.             Outline   -  Tell whether you want an outline around the whole graph
  145.                          or not. You also have your basic Color, Thickness and
  146.                          Style choices. The default is ON and color 15.
  147.  
  148.  
  149.             **** For Bars and Lines -- Pie information to follow ****
  150.  
  151.             X axis line,
  152.             Y axis line,
  153.             Vert Grid,
  154.             Hor Grid   - Tell whether you want them and select Color, etc.  The
  155.                          axis defaults are ON and 15.  The grids default to OFF.
  156.             Annotation - Tell if you want the values and/or labels to be shown
  157.                          and where (most of the time).  The choices are "DO NOT
  158.                          DISPLAY", "INTERNAL", "EXTERNAL" and "BOTH" (internal 
  159.                          and external). You will have to play with this some to
  160.                          get it where you like it.  It would take the rest of
  161.                          this file to try to explain all the possibilities and
  162.